IApi.WriteIOAlias method

Writes the alias index into a real or simulated I/O module. The alias index allows you to reorder the list of modules if the cabling does not match the program.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError WriteIOAlias(
       int Index,
       int Alias
)

Function ReadIOAlias(
       Index As Integer,
       Alias As Integer
) As KsError

Parameters

Index

Type: int

The actual index of an I/O module. Indexes are zero based. Aliases affect this parameter.

Alias

Type: int

The alias index to use, in place of the index of the I/O module. Indexes are zero based.

Return value

Type: KsError

A return code of a method.

Remarks

WriteIOAlias can only be called once a link is established and started.
The alias index can be outside the actual index range of the I/O modules.
Remember to call EnableAliases after enabling the alias indexes for the parameters of axes and I/O modules in all functions.

Usable EtherCAT states

ecatOP

Examples

N/A